home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 2 / Amiga Tools 2.iso / tex / macros / source / contrib / supported / xypic / install.textures < prev    next >
Text File  |  1995-03-15  |  20KB  |  471 lines
  1.  
  2.   ===============================================================
  3.   INSTALLING THE XY-pic DIAGRAM TYPESETTING MACROS ON A MACINTOSH
  4.   ===============================================================
  5.  
  6. This file assumes that you have downloaded the `xy212mac.sit.hqx' 
  7. file and have decoded this and have expanded and extracted all files
  8. and folders from the resulting compressed archive. 
  9.  
  10. It also assumes that you have the TeX application called Texturesª,
  11. from Blue Sky Research, Portland, Oregon (version 1.4 or later).
  12.  
  13.  
  14. The main difference between Texturesª and other TeX implementations
  15. is the way in which fonts are handled. Here we deal with Macintosh
  16. font suitcases containing bitmap versions of the special fonts that
  17. XY-pic uses, as well as a suitcase containing the font metrics. 
  18.  
  19. For users of OzTeX a folder called `for OzTeX only' contains .pk fonts, 
  20. .tfm files and some configuration files. The file `INSTALL.OzTeX' 
  21. explains how to install these. 
  22.  
  23. For any other implementations of TeX on the Macintosh, there may be 
  24. sufficient files here to install XY-pic. If not then obtain the full 
  25. XY-pic distribution from one of the usual ftp sites: 
  26.     ftp.mpce.mq.edu.au  in the  /pub/maths/TeX  directory;
  27.     ftp.diku.dk          in the  /diku/users/kris/TeX  directory;
  28.     CTAN in the   tex-archive/macros/generic/diagrams/xypic  directory;
  29.       e.g. at  ftp.shsu.edu, ftp.tex.ac.uk  and  ftp.dante.de.
  30.  
  31. (If this is still insufficient, then the author would like to know
  32. what other resources are required and why. 
  33. Contact him by email at the address given below.)
  34.  
  35.  
  36. From version 2.10, the source files are NOT included with the
  37. Macintosh Distribution, as doing this would add almost 1 MByte
  38. to its overall size. Obtain them from the sites listed above.
  39.  
  40.  
  41. I'll also assume that you use a 300 dots per inch laser printer 
  42. (like the Apple laserwriter or HP laserjet).
  43.  
  44. Contents:
  45.  
  46.   -0- Simple Installation, for experienced users
  47.   -1- Copyleft
  48.   -2- Updating from version 2.6 (and earlier) or 2.7 -- 2.11
  49.   -3- Overview of files and where they should be installed
  50.   -4- Manuals and Sources
  51.   -5- Memory Requirements
  52.   -6- Bugs & comments
  53.  
  54. ----------------------------------------------------------------------
  55.   -0- SIMPLE INSTALLATION, for EXPERIENCED USERS
  56. ----------------------------------------------------------------------
  57.  
  58. If you have never used XY-pic before and are experienced as a user 
  59. of Texturesª, then the following instructions should be sufficient
  60. to get XY-pic installed.
  61.  
  62. You should have extracted two folders called `for TeX inputs folder' 
  63. and `for TeX fonts folder' from the Stuffit archive. 
  64.  
  65. Simply copy the contents of these folders to the places indicated by
  66. their names; namely the font suitcases go into the `TeX Fonts` folder,
  67. while the `xy*.tex` source code files go into the `TeX inputs` folder.
  68.  
  69.  
  70. If these instructions do not make sense to you, or you get any warning
  71. messages when you try to carry out these steps, then...
  72.  
  73.     STOP immediately!
  74.  
  75. ... read the rest of this file, to learn more about XY-pic, what all
  76. the files contain and how they should be installed on your Macintosh. 
  77.  
  78. If you had no trouble with this installation, then... enjoy XY-pic!
  79. Please do us the courtesy of reading the rest of this file anyway.
  80. In particular please respect the following Copyright message, making
  81. sure that any copies that you may distribute are complete, so that
  82. others can equally enjoy XY-pic (... and so that we do not get irate
  83. messages about missing features).
  84.  
  85. ----------------------------------------------------------------------
  86.   -1- COPYLEFT
  87. ----------------------------------------------------------------------
  88.  
  89. This distribution of the XY-pic package is distributed with copyleft:
  90.  
  91.   Copyright (c) 1991-1994    Kristoffer H. Rose  <kris@diku.dk>
  92.   Copyright (c) 1994         Ross Moore  <ross@mpce.mq.edu.au>
  93.  
  94.   The XY-pic package is free software; you can redistribute it and/or
  95.   modify it under the terms of the GNU General Public License as
  96.   published by the Free Software Foundation; either version 2 of the
  97.   License, or (at your option) any later version.
  98.  
  99.   The XY-pic package is distributed in the hope that it will be
  100.   useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  101.   of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  102.   General Public License for more details.
  103.  
  104.   You should have received a copy of the GNU General Public License
  105.   along with this package; if not, write to the Free Software
  106.   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  107.  
  108. What this means is that if you install XY-pic then you should (1) make
  109. sure that the file COPYING is accessible to the users, and (2) be
  110. prepared to provide XY-pic (including sources) to any of your users
  111. that request it (you may charge a fee for this if you are so inclined).
  112.  
  113. ----------------------------------------------------------------------
  114.   -2- UPDATING FROM VERSION 2.6 (AND EARLIER) OR 2.7 -- 2.11
  115. ----------------------------------------------------------------------
  116.  
  117. XY-pic version 2.7 was almost a complete rewrite of XY-pic. The update
  118. to version 2.8 fixed numerous small bugs and added PostScript \special 
  119. commands that could be used instead of the XY-pic fonts. 
  120. In version 2.9 the PostScript functionality was extended to include 
  121. effects such as rotation and scaling of diagrams and text, variable 
  122. line thickness and colour support. There were also improvements in many
  123. other aspects of the way XY-pic works.
  124.  
  125. A Macintosh version of 2.9 was never released, as some of the claimed
  126. effects did not actually work. These bugs were fixed for version 2.10.
  127.  
  128. Version 2.11 included the `Graph Combinator' feature which provides
  129. a simplified interface for many common classes of diagrams.
  130. Also some minor bugs were fixed, both in code and documentation.
  131.  
  132. This version 2.12 is necessary to accommodate a change to AMS-LaTeX
  133. which otherwise seriously conflicts with internal structure of XY-pic. 
  134. A new `Polygon' feature has been added and many subtle bugs fixed. 
  135. Also much of the `curve' code has been improved, especially for
  136. `curved arrows'.
  137.  
  138.  
  139. Also, version 2.12 provides for a new font for arrow-tips, in the style
  140. of those arrowheads that appear in the Computer Modern fonts. 
  141. Fonts   xycmat10  and  xycmbt10  have always been included in the font 
  142. suitcases (since version 2.6) but not used due to errors in the metrics.
  143. This has now been rectified --- this means that the font metric file  
  144. `XY-pic metrics'  MUST BE REPLACED with the latest version --- having 
  145. modification date: 20 August 1994 --- but the fonts are unchanged.
  146.  
  147.  
  148. XY-pic version 3.1 is due before the end of 1994. 
  149. Among the new features will be one for typesetting `crossing strings',
  150. in particular elegant representations of `knots'. A feature for drawing
  151. `chemical structures' may also be ready. 
  152.  
  153.  
  154. If you already have version 2.7 (or later) installed then:
  155.  
  156. * Copy the file:  `XY-pic metrics' , to be found in the folder called
  157.  `for TeX fonts folder', into your `TeX Fonts' folder.
  158.  
  159. + The file `XY-pic fonts' contains no new fonts, so need not be updated.
  160.  
  161. + With version 7.1+ of the Macintosh operating system, you can place 
  162.   font suitcases in the Fonts subfolder of the system folder. 
  163.   However the `XY-pic metrics' suitcase MUST be in the `TeX Fonts' folder.
  164.  
  165. + Extra font sizes are available in a separate archive called `xymacxf.sit',
  166.   see below for more details. These can be installed locally, if desired. 
  167.   Alternatively the extra sizes may be installed on a file-server; 
  168.   then place an `alias' (requires system 7.0+) to them within the `TeX Fonts' 
  169.   folder --- the server will mount when Textures is launched.
  170.  
  171.  
  172. * Copy the contents of the `for TeX inputs folder' into the 
  173.   obvious place, i.e. the `TeX Inputs' folder, allowing these files to 
  174.   replace the existing ones of the same name. 
  175.  
  176. + With the system-7 operating system, you can place the files/folders
  177.    elsewhere, and place aliases to them within the `TeX Inputs' folder.
  178.  
  179.  
  180.  
  181. If you already have version 2.6 (or some earlier version) installed then
  182. note the following:
  183.  
  184. * All the fonts have been redone AND renamed.  Thus installing the new
  185.   version will not break any typeset files you already have that use 
  186.   the old fonts. However if you intend to keep the old version on your
  187.   system then you should rename the font and metrics suitcases to
  188.   `XY-pic fonts.old' and `XY-pic metrics.old'.
  189.  
  190. * The distribution contains new versions of the files `xypic.tex' and
  191.   `xypic.sty' that load XY-pic 2.12 in a special compatibility mode.
  192.   Thus re-TeX'ing your source documents will create typeset versions 
  193.   using the new fonts. If you wish to keep the old `xypic.tex' and
  194.   `xypic.sty' then you should rename them before installation.
  195.  
  196. * There are a few points where the backwards compatibility is not
  197.   perfect -- these are noted in the documentation.
  198.  
  199.  
  200. ----------------------------------------------------------------------
  201.   -3- OVERVIEW OF FILES AND WHERE THEY SHOULD BE INSTALLED
  202. ----------------------------------------------------------------------
  203.  
  204. You need to install the following groups of files:
  205.  
  206. AVAILABILITY: These three files contain general information and should
  207. be installed in a publicly readable place (if necessary you may give
  208. them an `xy' prefix):
  209.  
  210.   TRAILER                         summary of features and availability
  211.   INSTALL.Textures         how to install XY-pic for Textures (this file)
  212.   INSTALL.other         how to install XY-pic on other systems
  213.   COPYING                         GNU General Public License
  214.  
  215. MACROS: This group contains TeX/LaTeX macro files that must be
  216. installed in a place which TeX/LaTeX will search (this is normally 
  217. the `TeX Inputs' folder):
  218.  
  219.   xy.tex             XY-pic bootstrap and kernel macros
  220.   xy.sty             LaTeX 2.09 `style option' interface
  221.   xyidioms.tex        format-dependent idioms
  222.   xyall.tex             loads all options
  223.  
  224.   xytex.ini             Use with VirTeX to dump a format: Plain+XYpic
  225.   xylatex.ini        Use with VirTeX to dump a format: LaTeX+XYpic
  226.  
  227.   xypic.sty             `Version 2 Compatibility' interface
  228.   xypic.tex             `Version 2 Compatibility' interface
  229.   xyv2.tex              `Version 2 Compatibility' feature
  230.  
  231.   xycmtip.tex        `Computer Modern Tips' extension
  232.   xycurve.tex        `Curves and Splines' extension
  233.   xycolor.tex        `Colour Support' extension
  234.   xyframe.tex        `Frames and Brackets' extension
  235.   xyline.tex         `Line Styles' extension
  236.   xyrotate.tex       `Rotation and Scaling' extension
  237.  
  238.   xydummy.tex        Template for new extensions
  239.  
  240.   xyarrow.tex        `Arrows and Paths' feature
  241.   xymatrix.tex       `Matrix and Diagrams' feature
  242.   xy2cell.tex        `Categorical 2-cells' feature
  243.   xygraph.tex        `Graph Combinator' feature
  244.   xypoly.tex         `Polygon' feature
  245.  
  246.   xyps.tex             `PostScript Back-end'
  247.   xyps-c.tex         PostScript implementation of xycolor.tex
  248.   xyps-l.tex         PostScript implementation of xyline.tex
  249.   xyps-r.tex         PostScript implementation of xyrotate.tex
  250.  
  251.   xyps-txt.tex        DVI-driver for `Textures'
  252.   xyps-???.tex        other  DVI-drivers
  253.  
  254.  
  255. All the above files have been conveniently placed in a folder called
  256. `for TeX inputs folder'. Simply copy its entire contents into your
  257. `TeX Inputs' folder (after having appropriately dealt with any previous 
  258. version, as described above).
  259.  
  260.  
  261. POSTSCRIPT DICTIONARY: 
  262. Since XY-pic version 2.8 it has been possible to have diagrams drawn using
  263. PostScript commands rather than using the XY-pic fonts. This results in 
  264. pictures which are sharper and cleaner. If this feature is to be used
  265. then it helps to also use the header file:
  266.  
  267.   xy212dict.ps        PostScript Header for XY-pic, version 2.12
  268.  
  269. It is not necessary to use this header file; furthermore the reference 
  270. manual describes how it can be generated if needed from `xyps.tex'.
  271.  
  272.  
  273.  
  274. XY-pic FONTs and METRICs: the two font suitcase files, called `XY-pic fonts'
  275. and `XY-pic metrics', are found in the folder called `for TeX fonts folder'.
  276. Simply move these into the Texturesª `TeX Fonts' folder (after having
  277. appropriately dealt with any previous version, as described above). 
  278.  
  279. When you next launch the Texturesª application the following fonts will
  280. then be available for use in typesetting with the XY-pic macros.
  281.  
  282.   xydash10     straight line segments at 128 different angles
  283.   xyatip10     top half of an arrow head at 128 different angles
  284.   xybtip10     bottom half of arrow head at 128 different angles
  285.   xybsql10     small quarter turns, for hooks, turns and wavy lines
  286.   xycirc10     eighth-turns at 16 different radii, 8 per radius
  287.  
  288. These fonts are each provided in four screen sizes: 100% 120% 200% 240%
  289. and in one size for laser-printing at 300dpi: 417%.
  290.  
  291. If more sizes are required then either:
  292.  
  293.   a) get the file `xymacxf.sit.hqx' from ftp.mpce.mq.edu.au.  
  294.      These expand to give suitcases containing the above sizes plus extra
  295.      laserwriter sizes, corresponding to magsteps 0.5, 1, 2, 3, 4, 5.
  296.      (The xycirc10 is separate since these fonts occupy more space than
  297.      any of the others --- 2.2 MByte!! ) 
  298.  
  299. or...
  300.  
  301.   b) generate extra sizes using Metafont. 
  302.        The appropriate xy*.mf source files are included in the sub-directory
  303.         `mfinputs'. This can be obtained from the ftp sites listed above.
  304.  
  305.     xydash10.mf              kernel font sources
  306.       xyatip10.mf
  307.       xybsql10.mf
  308.      xybtip10.mf
  309.       xycirc10.mf
  310.  
  311.  
  312. With the xy*.tex and xy*.sty input files installed in the `TeX Inputs'
  313. folder, and the font suitcases installed in the `TeX Fonts' folder, 
  314. you should be ready to use XY-pic to typeset some diagrams.
  315.  
  316.  
  317. ----------------------------------------------------------------------
  318.   -4- MANUALS and SOURCES
  319. ----------------------------------------------------------------------
  320.  
  321. The `XY-pic User's Guide' and `XY-pic Reference Manual' are provided
  322. with this distribution. They are in the form of pre-typeset Texturesª 
  323. documents. These files are Finder-locked and should NOT be re-typeset.
  324. (Indeed it should not be possible to typeset this file without first
  325. removing the safe-guards which have been put in place.)
  326.  
  327. It is a good idea to test your installation of XY-pic by typesetting 
  328. portions from the manuals. Of course you will first have to obtain
  329. these sources from one of the ftp sites listed above, or elsewhere.
  330.  
  331. Alternatively you can try to typeset the complete manuals, using LaTeX, 
  332. from the documents `xyguide.man' and `xyrefer.man' in the directory `src` 
  333. where they are located along with all the input and non-standard style 
  334. files that they need. 
  335. You will need to obtain ALL the files in this directory.
  336. (There is a file named `xy***.doc' for each macro file `xy***.tex' 
  337. placed in the `TeX Inputs' folder.) 
  338. For this to be successful your Textures application will need a 
  339. memory partition of at least 4.5 MBytes.
  340.  
  341. The normal sequence should be followed: LaTeX, BibTeX, LaTeX, LaTeX
  342. to get all the references and the bibliography typesetting correctly.
  343. These manuals have been checked to work correctly with LaTeX 2.09 and
  344. LaTeX2e.
  345.  
  346. An alternative way to get the manuals is to download the files called
  347. `xyguide.ps.Z' and `xyrefer.ps.Z' from one of the ftp-sites.
  348. These files were created using the `xyps' PostScript option, so should
  349. produce a higher quality printed output on a PostScript printer of
  350. resolution 300dpi (due to use of bitmapped Computer Modern fonts).
  351.  
  352.  
  353.  
  354. EXTRA files, not provided with the Macintosh distribution:
  355.  
  356. The following files are provided with the full XY-pic distribution, 
  357. for systems that do not use font suitcases, e.g. OzTeX. If you need
  358. them then you should get the complete XY-pic distribution from one
  359. of the ftp sites and follow the installation instructions provided.
  360.  (The file INSTALL.OzTeX contains instuctions specific to OzTeX.)
  361.  
  362. TEX FONT METRIC files:
  363.  
  364.   texfonts/xydash10.tfm          kernel TeX font metric files
  365.   texfonts/xyatip10.tfm    
  366.   texfonts/xybsql10.tfm
  367.   texfonts/xybtip10.tfm
  368.   texfonts/xycirc10.tfm
  369.  
  370. BITMAP FONTS: These are for installations that can't use the METAFONT
  371. sources directly but have driver for a 300 dpi laserprinter that
  372. accepts PK bitmap font files.  They should be installed where DVI
  373. previewers and printer drivers will see them (e.g., with un*x, the
  374. `xdvi' program should see them through the XDVIFONTS environment
  375. variable):
  376.  
  377.   pkfonts/cx300         kernel font bitmaps for the 5 XY-pic fonts
  378.   pkfonts/cx329    
  379.   pkfonts/cx360
  380.  
  381.  
  382. METAFONT sources are in the `src' folder as described above.
  383.  
  384. DVI-files:
  385.  
  386.   xyguide.dvi              User's Guide
  387.   xyrefer.dvi              Reference Manual
  388.  
  389. These dvi-files are provided primarily for non-Textures users. 
  390. Using the `DVI-Tool' application, they can be converted into the 
  391. usual form for documents typeset using Texturesª. However this is
  392. not necessary as it has been done already: the `XY-pic User's Guide'
  393. and `XY-pic Reference Manual' described above.
  394.  
  395. ----------------------------------------------------------------------
  396.   -5- MEMORY REQUIREMENTS
  397. ----------------------------------------------------------------------
  398.  
  399. Although many efforts have been made to make XY-pic work quickly and 
  400. efficiently, the nature of the diagrams for which it is designed are
  401. sometimes necessarily quite large and consume a significant amount of
  402. TeX's available memory. Do not be surprised if it takes a long time
  403. to typeset a diagram having several rows and columns of entries.
  404.  
  405. Usually I work with a memory partition set at 4 MBytes, on a Mac IIci
  406. or Macintosh PowerBook. For instance, when typesetting the User's Guide, 
  407. using LaTeX-2e and XY-pic, nearly all of this 4 MBytes is required.
  408. The Reference Guide requires even more than this: allowing 8 MByte was 
  409. a luxury that I could afford, but I suspect that 4.5 MByte would have 
  410. been sufficient. Mind you, although shorter the Users' Guide actually
  411. takes significantly longer to typeset than does the Reference Manual.
  412.  
  413. ----------------------------------------------------------------------
  414.   -6- BUGS & COMMENTS
  415. ----------------------------------------------------------------------
  416.  
  417. This version of XY-pic is numbered 2.12. 
  418.  
  419. * Many quite subtle bugs in earlier code have been identified and fixed.
  420.   In particular curves are much faster and more efficient. 
  421.   
  422. * The powerful `Graph Combinator' feature has been extended. 
  423.   
  424. * A new `Polygon' feature has been added, which greatly assists the
  425.   construction of diagrams in which objects are located in a regular
  426.   way, but not necessarily on a rectangular grid. 
  427.   
  428.  
  429. The ftp sites ftp.diku.dk and ftp.mpce.mq.edu.au are kept up-to-date 
  430. with the latest release, and patches to any serious bugs that users 
  431. report. 
  432.  
  433. Reports on any problems that you may encounter will be appreciated,
  434. especially opinions you have on how the usefulness of XY-pic can be 
  435. improved. Please report these, concerning XY-pic itself, either to
  436.  
  437.   Electronic mail (Internet): kris@diku.dk     [preferred]
  438.  
  439.   Paper mail:   Kristoffer H. Rose
  440.                 DIKU, University of Copenhagen
  441.                 Universitetsparken 1
  442.                 DK--2100 K{\o}benhavn {\O}
  443.                 DENMARK
  444.  
  445.   Fax +45 35321401  attn: L.Wiese/K.Rose
  446.  
  447. or to...
  448.  
  449.   Electronic mail (Internet): ross@mpce.mq.edu.au   [preferred]
  450.  
  451.   Paper mail: Ross Moore
  452.               Mathematics Department, 
  453.               Macquarie University
  454.               North Ryde, NSW 2109
  455.               AUSTRALIA
  456.  
  457.   Fax +61 2 8508114  attn: R.Moore
  458.  
  459. In particular, comments or reports related to the Macintosh distribution
  460. should be sent to Ross Moore, using the address given above.
  461.  
  462. ----------------------------------------------------------------------
  463.  
  464. This is the end of `INSTALL.Textures'.  We hope you'll enjoy XY-pic !
  465.  
  466. --
  467. Ross MOORE                               Internet: ross@mpce.mq.edu.au
  468. Mathematics Dept, Macquarie University, Nth Ryde, NSW 2109,  AUSTRALIA
  469. phone: 612 8508955      fax: 612 8508114
  470. --
  471.